Skip to content

docs: show how to use ShellIcons with ShellUI - #83

Open
Shewart wants to merge 1 commit into
mainfrom
docs/shellicons
Open

Shewart wants to merge 1 commit into
mainfrom
docs/shellicons

Conversation

@Shewart

@Shewart Shewart commented Nov 6, 2026

Copy link
Copy Markdown
Contributor

Closes #60.

A new page, docs/shellicons.md, linked from the README, covering:

  • Installing ShellIcons.Blazor (--prerelease, since 0.2.0-alpha is the latest).
  • Importing @using ShellIcons, never ShellIcons.Icons. ShellUI's Badge, Calendar, Table, Command, Sheet and Timeline are also Lucide names, so that import fails with RZ9985. The issue suggested a namespace alias as a workaround, but ShellIcons' own guide says Razor ignores aliases and the icon renders blank. The page recommends ShellIcons 0.2's {Name}Icon components and Icon.{Name}() instead.
  • Passing icons to the six ShellUI icon parameters, and which of them size the icon themselves (StatCard, TreeViewItem, TimelineItem) and which need a size (Alert, Callout, ContextMenuOption).
  • Icons in buttons (Button doesn't size or space its content), colours, accessibility, and click handlers.

Checked

  • Every snippet compiles in a scratch Razor project referencing this branch's ShellUI.Components and ShellIcons.Blazor 0.2.0-alpha.
  • Adding @using ShellIcons.Icons to that project fails with RZ9985: Multiple components use the tag 'Badge'.

Covers installing ShellIcons.Blazor, importing ShellIcons rather than
ShellIcons.Icons (whose plain names clash with Badge, Calendar, Table,
Command, Sheet and Timeline), passing icons to ShellUI's Icon
parameters at the right size, and icons in buttons and text.

Closes #60
Copilot AI balanced review requested due to automatic review settings November 6, 2026 17:06

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copilot was unable to review this pull request because the user who requested the review has insufficient remaining quota. Try requesting a review at a lower effort level.

An organization owner can choose the repository organization as the billing source for reviews requested by members with a paid Copilot license. Learn about Copilot code review billing.

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Docs: using ShellIcons with ShellUI

2 participants